2.1.3. Response
Field | Description | Type | Notes |
status | success | ||
data | a map with the returned log | Array |
data
Array Structure
Field | Description | Type | Notes |
transactions | an array of transactions | Array | |
pagination | map of pagination information | object | |
statistics | map of the statistics information | object |
transactions
Array Structure
Field | Description | Type | Notes |
id | transaction ID | string | |
device_sn | device serial number | string | |
bank_host | host bank name | string | |
merchant_id | merchant IDs | string | |
terminal_id | terminal IDs | string | |
transaction_type | transaction type | string | “PURCHASE”, “REFUND” etc |
approval_number | authorization number | string | |
amount | amount | integer | in cents |
transaction_datetime | transaction date and time | string | ISO 8601 |
result_type | transaction result | string | “APPROVED”, “DECLINED” |
rrn | retrieval reference number | string | |
inn | fiscal ID | string | |
card_product_name | card product name | string | |
org_name | organization name | string | |
org_name_place | point of sale name | string | |
receipt_number | receipt number | string | |
bank_card_number | masked bank card number | string | |
mcc | merchant category code | string | |
read_type | card reading method type | string | |
result_code | result code | string |
pagination
Object Structure
Field | Description | Type | Notes |
current_page | current page number | integer | |
per_page | number of records per page | integer | |
total_pages | total number of the pages | integer | |
total_records | total number of the records | integer |
statistics
Object Structure
Field | Description | Type | Notes |
total_amount | successful transactions amount | integer |
Exit codes:
200 – success
400 – invalid request parameters
Code structure
{
"status": "string, response status ('success')",
"data": {
"transactions": [
{
"id": "string, transaction ID",
"device_sn": "string, device serial number",
"bank_host": "string, host bank name",
"merchant_id": "string, merchant ID",
"terminal_id": "string, terminal ID",
"transaction_type": "string, transaction type ('PURCHASE', 'REFUND', etc.)",
"approval_number": "string, authorization number",
"amount": "integer, amount in cents",
"transaction_datetime": "string, transaction date and time (ISO 8601)",
"result_type": "string, transaction result ('APPROVED', 'DECLINED')",
"rrn": "string, retrieval reference number",
"inn": "string, fiscal ID",
"card_product_name": "string, card product name",
"org_name": "string, organization name",
"org_name_place": "string, point-of-sale name",
"receipt_number": "string, receipt number",
"bank_card_number": "string, masked bank card number",
"mcc": "string, merchant category code",
"read_type": "string, card reading method type",
"result_code": "string, result code"
}
],
"pagination": {
"current_page": "integer, current page number",
"per_page": "integer, number of records per page",
"total_pages": "integer, total number of pages",
"total_records": "integer, total number of records"
},
"statistics": {
"total_amount": "integer, total amount of successful transactions in cents"
}
}
}